Search for Content Items

This example demonstrates how to manage content items in Pyramid.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mySite.com/api3/";

// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"abc123!"
},"",false);
log("got token "+token);

//step 2: get the default tenant ID
let defaultTenant=callApi("access/getDefaultTenant",{
},token // admin token generated above
);

//step 3: return the ID of the public root folder for the tenant from step 2
let tenentPublicFolder = callApi("content/getTenantPublicOrGroupFolder",{
	"validRootFolderType": 1,//the public folder of the default tenant
	"tenantId": defaultTenant
},token // admin token generated from step 1 above
);

//step 4: add a new folder to the public folder from step 3
let folderCreation = callApi("content/createNewFolder",{
	"parentFolderId": tenentPublicFolder.id,
	"folderName": "new folder"
},token);
let folderId=folderCreation.modifiedList[0].id;

//step 5: find roles
let findRole = callApi("access/findRoles",{
	"searchValue": "role1",
	"searchMatchType": 2//SearchMatchType.Equals
},token);
let roleId=findRole[0].roleId;
log("found role with id= "+ roleId);

//step 6:add the role we found in step 5 to the folder we created (folderId) in step 4
let addRoleToFolder= callApi("content/addRoleToItem",{
	"itemId": folderId,
	"roleId": roleId//SearchMatchType.Equals
},token);

//step 7: read in a Pyramid Import/Export ('PIE') file
let file="http://myOtherSite.com/Sample.pie";
let pieFile=readPieFile(file);

//step 8: import the PIT file into the folder from step 4
let importContent = callApi("content/importContent",{
	"rootFolderId": folderId, //from step 4
	"fileZippedData": pieFile, //the file's content from step 7
	"clashDefaultOption":1,//ClashDefaultOption.REPLACE_FILE like default
	"rolesAssignmentType":3//RoleAssignmentType.ForceParentFolderRoles take roles from parent folder
},token);
let itemId=Object.keys(importContent.importDscMap)[0];

//step 9: optional, search for the item we just imported, it's id is itemId
let findContentItem = callApi("content/findContentItem",{
	"searchString":"import",
	"filterTypes":[3],//ContentTypeObject.DataDiscoveryv
	"searchMatchType":2,//SearchMatchType.Equals
	"searchRootFolderType":1//SearchRootFolderType.Public
},token);


//step 10: check if you need to run datasource changer 
// (since the datasource that created this report dosen't exists on this server)
if(importContent.importDscMap[itemId][0].needsToPerformDsc){

	// step 10A: get item's data source connection
	let correntConnectionStringId=importContent.importDscMap[itemId][0].connectionStringProperties.id
	
	//step 10B: run the data source changer on the items
	let changedDatasource = callApi("dataSources/changeDataSource",{
		"fromConnId":correntConnectionStringId,
		"toConnId":"55ff277a-53ff-4c39-8f15-5651f1026a2d",//retrive this id using 'getAllConnectionStrings'
		"itemId":itemId
	},token);
}

//step 11: copying the imported item to the tenant root folder
let copyItems = callApi("content/copyItems",{
	"itemsForMove":[itemId],
	"destinationFolder":tenentPublicFolder.id		
},token);

//step 12: remove roles from the folder but not from the item
let removeRoleFromCreatedFolder= callApi("content/removeRolesFromItem",{
	"itemId": folderId,
	"roleIds": [roleId]
},token);

//step 13: hard delete the folder (permanently)
let folderDeletion = callApi("content/purgeContentItems",[
folderCreation.modifiedList[0].id
],token);

//step 14: soft-delete the items
let itemSoftDeletion = callApi("content/deleteItems",[
copyItems.modifiedList[0].id
],token);




function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

//example function to read in the contents of a 'PIE' file that contains
//exported Pyramid content.
function readPieFile(file){
	var rawFile = new XMLHttpRequest();
	rawFile.open("GET", file, false);
	rawFile.send(null);
	rawFile.onreadystatechange = function () {
		if (request.readyState === 4 && request.status === 200) {
			return request.responseText;
        }
    }
}

This example demonstrates how to run queries and slicers (parameters) programmatically to extract results.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";


// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"abc123!"
},token,false);


//step 2: find a parameter definition called "param x". Parameters are saved items to drive slicers
let calculation = callApi("content/findContentItem",{
	"searchString": "param x",
	"filterTypes": [2],
	"searchMatchType": 2,
	"searchRootFolderType":0
},token // admin token generated above
);

let paramId = calculation[0].id;

//step 3: get the parameter's elements
let parameterElements = callApi("analytics/getParameterElements",paramId,token);

let members = parameterElements.members // list for members
console.log(members);

//step 4: find a data discovery called "report x"
let dataDiscovery = callApi("content/findContentItem",{
	"searchString": "report x",
	"filterTypes": [3],
	"searchMatchType": 2,
	"searchRootFolderType":0
},token // admin token generated above
);


let reportId = dataDiscovery[0].id;

//step 5: extract the report results as JSON that have been filtered by the first member of the parameter found in step 3
let queryResult = callApi("analytics/extractQueryResult",{
	  "itemId":reportId,
      "exportType":0, //JSON
      "exportOptions": {},
      "externalParameters": {
        "reportFilters" : [
         {
         "value": members[0].uniqueName
         }
        ]
      }
},token);

console.log(JSON.parse(queryResult));


// ##### optional generic logging method for debugging ##############
function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

		

This example demonstrates how to get model structure create custom furmula and list and use it to create discover.

using System;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

Main();
static void Main()
{
    // base configurations
    Configuration conf = new Configuration();
    conf.BasePath = "http://mysite.com";

    //authenticate user - returns the authentication Token
    AuthenticationServiceApi api = new AuthenticationServiceApi(conf);
    string token = api.AuthenticateUser(new UserCredentials(
		username: "adminUser",
		password: "abc123!"
		));
    Console.WriteLine("Api token : " + token);

    // set token for further APIs
    conf.AddApiKey("paToken", token);
    GlobalConfiguration.Instance = conf;

    // find folder to save
    ContentServiceApi contentApi = new ContentServiceApi();
    Guid folderId = getFolder(contentApi, "FolderName");

    //initialize the datasources api
    DataSourcesServiceApi dataSourcesApi = new DataSourcesServiceApi();

    //get the connection string for the model
    ConnectionSearchCriteria cssc = new ConnectionSearchCriteria(
        serverSearchCriteria: new SearchCriteria(
            searchValue: "In-Memory DB",
            searchMatchType: SearchMatchType.Equals
            ),
        databaseSearchCriteria: new SearchCriteria(
            searchValue: "SampleDemo",
            searchMatchType: SearchMatchType.Equals
            ),
        modelSearchCriteria: new SearchCriteria(
            searchValue: "SampleDemo",
            searchMatchType: SearchMatchType.Contains
            )
        );
    Guid connectionStringId = Guid.Parse(dataSourcesApi.FindModelConnection(cssc)[0].Id);
    Console.WriteLine("Connection String Id : " + connectionStringId);

    //find theme
    ThemesServiceApi themesApi = new ThemesServiceApi();
    string themeId = themesApi.FindThemeByName(new SearchCriteria(searchValue: "Pyramid", searchMatchType: SearchMatchType.Contains))[0].ThemeId;
    Console.WriteLine("Theme Id : " + themeId);

    //get the model definition
    ModelingModel mom = dataSourcesApi.GetModelStructure(connectionStringId.ToString());

    // create custom list and formula
    AnalyticsServiceApi analystApi = new AnalyticsServiceApi();
    Guid listId = addList(analystApi, connectionStringId, folderId, mom);
    Guid formulaId = addFormula(analystApi, connectionStringId, folderId, mom);

    // create discovery
    addDiscovery(analystApi, connectionStringId, folderId, formulaId, listId, themeId, mom);
}

// find folder from user private folder with specific name
static Guid getFolder(ContentServiceApi contentApi, string folderName)
{
    ContentSearchParamsObject searchParams = new ContentSearchParamsObject(
        searchString: folderName,
        filterTypes: new List<ContentTypeObject> { ContentTypeObject.Folder },
        searchMatchType: SearchMatchType.Equals,
        searchRootFolderType: SearchRootFolderType.Private
        );

    List<PyramidContentItem> folders = contentApi.FindContentItem(searchParams);
    Guid folderId = Guid.Parse(folders[0].Id);
    Console.WriteLine("Folder id : " + folderId);
    return folderId;
}

// create custom list for the product.color hierarchy to filter 2 values from it's members
static Guid addList(AnalyticsServiceApi analystApi, Guid connectionStringId, Guid folderId, ModelingModel mom)
{
    // get unique name from the model
    String uniqueName = getColumnUniqueNameFromModel(mom, "products", "Color");
    // create the formula for exclusion of specific members
    String formulaSyntax = String.Format("{{Except({{AllMembers({0})}},{{{0}.[Multi],{0}.[NA]}})}}", uniqueName);
    ListData customList = new ListData(connectionId: connectionStringId,
                    formulaSyntax: formulaSyntax,
                    itemName: "All Colors without NA and Multi",
                    description: "custom list item descriptions",
                    folderId: folderId,
                    parentDimension: "[products]", // parent table
                    parentHierarchy: uniqueName // parent hierarchy
                    );

    Guid listId = analystApi.SetList(customList);// create list
    Console.WriteLine("List id : " + listId);
    return listId;
}

// create custom measure formula to calculate the price per quantity
static Guid addFormula(AnalyticsServiceApi analystApi, Guid connectionStringId, Guid folderId, ModelingModel mom)
{
    // get unique names from the model
    var price = getMeasureUniqueNameFromModel(mom, "data", "price");
    var quantity = getMeasureUniqueNameFromModel(mom, "data", "quantity");

    FormulaData customFormula = new FormulaData(connectionId: connectionStringId,
                    formulaSyntax: price + "/" + quantity, // formula: "[measures].[data Price]/[measures].[data Quantity]"
                    itemName: "Price By Quantity",
                    folderId: folderId,
                    parentDimension: "[measures]" // global measures
                    );

    Guid formulaId = analystApi.SetFormula(customFormula);// create formula
    Console.WriteLine("Formula id : " + formulaId);
    return formulaId;
}

static void addDiscovery(AnalyticsServiceApi analystApi, Guid connectionStringId, Guid folderId, Guid formulaId, Guid listId, string themeId, ModelingModel mom)
{
    DiscoverData simpleDiscovery = new DiscoverData(connectionId: connectionStringId,
                    itemName: "Prices by categories",
                    description: "Discovery item descriptions",
                    folderId: folderId,
                    themeId: themeId,
                    visuals: new Visuals(cartesian:// create cartesian visual
                        new CartesianVisual(
                            visualType: CartesianVisualType.StackedColumnChart, // Chart type: StackedColumnChart
                            categories: new CartesianCategoriesDropZone(new List<CartesianCategoriesHierarchyChip> // categories dropzone chips
                            {
                                // add 2 chips of "product category" and "product sub category" in that specific order
                                 new CartesianCategoriesHierarchyChip(uniqueName:getColumnUniqueNameFromModel(mom,"products","product category")),
                                 new CartesianCategoriesHierarchyChip(uniqueName:getColumnUniqueNameFromModel(mom,"products","product sub category"))
                            }),
                            values: new CartesianValuesDropZone(new List<CartesianValuesMeasureChip> // values dropzone chips
                            {
                                // add the given measure formula created before as the values chip
                                new CartesianValuesMeasureChip(uniqueName:formulaId.ToString())
                            }),
                            filter: new CartesianFilterDropZone(new List<CartesianFilterChip> // filter dropzone chips
                            {
                                // set filter on the customer country
                                new CartesianFilterChip(hierarchy: new CartesianFilterHierarchyChip(
                                        uniqueName:getColumnUniqueNameFromModel(mom, "customers", "country"),
                                        filterType:FilterHierarchyType.DropDownMultiSelect // OPTIONAL: set the filter type to multi-select drop down
                                        ))
                            }),
                            color: new CartesianColorDropZone(new List<CartesianColorChip>// color dropzone chips
                            {
                                // set colors by the product color
                                new CartesianColorChip(hierarchy:new CartesianColorHierarchyChip(uniqueName:getColumnUniqueNameFromModel(mom, "products", "color")))
                            })
                        )
                        ),
                    elementSelections: new List<HierarchyElementSelection> // set the element selection for this discover
                    {
                        // filter the products.color by the created custom list
                        new HierarchyElementSelection(uniqueName:getColumnUniqueNameFromModel(mom, "products", "Color"),
                        all: false, // deselect the "All Members"
                        selectionsList:new List<ElementSelectionData>
                        { // add the created list as the element selection
                            new ElementSelectionData(selectionType: ElementSelectionDataType.List,
                            uniqueNames:new List<string>{ listId.ToString() }
                            )
                        }
                        )
                    }
                    );

    Guid ret = analystApi.CreateDiscover(simpleDiscovery);// create the discover
    Console.WriteLine("Discovery id : " + ret);
}

// find a measure unique name form a model structure by the give table name and measure name
static string getMeasureUniqueNameFromModel(ModelingModel mom, string tableName, string displayName)
{
    return mom.Tables
        .Where(t => t.DisplayName.Equals(tableName, StringComparison.OrdinalIgnoreCase))// find table by name
        .First().ModelingMeasures // get all table measures
        .Where(mm => mm.DisplayName.Equals(displayName, StringComparison.OrdinalIgnoreCase)) // find measure by name
        .First().UniqueName;
}

// find a column/hierarchy unique name form a model structure by the give table name and column name
static string getColumnUniqueNameFromModel(ModelingModel mom, string tableName, string displayName)
{
    ModelingColumn? modelingColumn = mom.Tables
        .Where(t => t.DisplayName.Equals(tableName, StringComparison.OrdinalIgnoreCase))// find table by name
        .First().ModelingColumns // get all table columns
        .Where(mc => mc.DisplayName.Equals(displayName, StringComparison.OrdinalIgnoreCase)) // find column by name
        .FirstOrDefault();

    if (modelingColumn != null)// if column found
        return modelingColumn.UniqueName;

    return mom.Tables
        .Where(t => t.DisplayName.Equals(tableName, StringComparison.OrdinalIgnoreCase)) // find table by name
        .First().ModelingHierarchies // get all table hierarchies
        .Where(mh => mh.DisplayName.Equals(displayName, StringComparison.OrdinalIgnoreCase)) // find hierarchy by name
        .First().UniqueName;
    // can be searched further to hierarchy levels if needed
}